VIVE 3DSP Native C Library  ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
audio_source.h
Go to the documentation of this file.
1 //========= Copyright 2016-2018, HTC Corporation. All rights reserved. ===========
2 #pragma once
3 #include "audio_engine.h"
4 #include "room.h"
5 
6 #ifdef __cplusplus
7 extern "C" {
8 #endif
9  namespace HTC_Vive3DSP_SDK {
10  /*****************************************************************************************************************/
11  /* Audio source */
12  /*****************************************************************************************************************/
13 
19  typedef struct vive_3dsp_internal_source vive_3dsp_audiosource;
20 
23  {
29  };
30 
43  vive_3dsp_source_create_object(vive_3dsp_context *api, VIVE_3DSP_CHANNELTYPE type, int sampleRate);
54  vive_3dsp_source_destroy_object(vive_3dsp_context *api, vive_3dsp_audiosource *src);
66  vive_3dsp_source_set_gain(vive_3dsp_context *api, vive_3dsp_audiosource *src, float gain);
78  vive_3dsp_source_bypassSmallSignal_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
90  vive_3dsp_source_set_bypassSmallSignalValueDB(vive_3dsp_context *api, vive_3dsp_audiosource *src, float gain);
102  vive_3dsp_source_muteFarDistantSource_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
114  vive_3dsp_source_set_muteFarDistantSourceRadius(vive_3dsp_context *api, vive_3dsp_audiosource *src, float radius);
126  vive_3dsp_source_set_position(vive_3dsp_context *api, vive_3dsp_audiosource *src, VIVE_3DSP_Vector3 pos);
138  vive_3dsp_source_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
150  vive_3dsp_source_spatializer_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
162  vive_3dsp_source_reverb_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
174  vive_3dsp_source_occlusion_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
186  vive_3dsp_source_graphic_eq_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
198  vive_3dsp_source_graphic_eq_set_gain(vive_3dsp_context *api, vive_3dsp_audiosource *src, float *pGainArray);
210  vive_3dsp_source_graphic_eq_set_channel_num(vive_3dsp_context *api, vive_3dsp_audiosource *src, size_t num);
222  vive_3dsp_source_parametric_eq_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
234  vive_3dsp_source_parametric_eq_set_frequency(vive_3dsp_context *api, vive_3dsp_audiosource *src, float *pFreqArray);
246  vive_3dsp_source_parametric_eq_set_gain(vive_3dsp_context *api, vive_3dsp_audiosource *src, float *pGainArray);
258  vive_3dsp_source_parametric_eq_set_Q(vive_3dsp_context *api, vive_3dsp_audiosource *src, float *pQArray);
270  vive_3dsp_source_parametric_eq_set_channel_num(vive_3dsp_context *api, vive_3dsp_audiosource *src, size_t num);
282  vive_3dsp_source_quasi_doppler_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
297  vive_3dsp_source_process(vive_3dsp_context *api, vive_3dsp_audiosource *src, float *in_buffer, float *out_buffer, int sampleLength);
310  vive_3dsp_source_drc_enable(vive_3dsp_context *api, vive_3dsp_audiosource *src, bool enable);
321  vive_3dsp_source_reset(vive_3dsp_context *api, vive_3dsp_audiosource *src);
333  vive_3dsp_source_set_input_channel(vive_3dsp_context *api, vive_3dsp_audiosource *src, VIVE_3DSP_CHANNELTYPE type);
345  vive_3dsp_source_set_min_volume(vive_3dsp_context *api, vive_3dsp_audiosource *src, float dB);
357  vive_3dsp_source_set_min_distance(vive_3dsp_context *api, vive_3dsp_audiosource *src, float distance);
369  vive_3dsp_source_set_max_distance(vive_3dsp_context *api, vive_3dsp_audiosource *src, float distance);
381  vive_3dsp_source_setDistanceMode(vive_3dsp_context *api, vive_3dsp_audiosource *src, VIVE_3DSP_DISTANCE_MODE mode);
393  vive_3dsp_source_setReverbMode(vive_3dsp_context *api, vive_3dsp_audiosource *src, VIVE_3DSP_REVERB_MODEL mode);
405  vive_3dsp_source_setBinauralReverbEngine(vive_3dsp_context *api, vive_3dsp_audiosource *src, VIVE_3DSP_BINAURAL_REVERB_ENGINE mode);
406 
418  vive_3dsp_source_set_doppler_order(vive_3dsp_context *api, vive_3dsp_audiosource *src, int order);
433  vive_3dsp_source_export_process(vive_3dsp_context *api, vive_3dsp_audiosource *src, float *in_buffer, float *out_buffer, int sampleLength);
434 
437  vive_3dsp_source_setHOAOrder(vive_3dsp_context *api, vive_3dsp_audiosource *src, int order);
439  vive_3dsp_source_set_current_room(vive_3dsp_context *api, vive_3dsp_audiosource *src, vive_3dsp_room *room);
441  vive_3dsp_source_leave_room(vive_3dsp_context *api, vive_3dsp_audiosource *src);
443  }
444 #ifdef __cplusplus
445 }
446 #endif
The vive_3dsp_audiosource structure represents the 3D audio source model.
VIVE_3DSP_API_STATUS
Definition: audio_engine.h:25
#define VIVE_3DSP_API_DLLEXPORT
Definition: audio_engine.h:6
VIVE_3DSP_REVERB_MODEL
Definition: audio_engine.h:87
VIVE_3DSP_CHANNELTYPE
Definition: audio_engine.h:42
The vive_3dsp_context structure represents the overall audio engine of 3D sound model.
Definition: vive_3dsp_api.h:15
The vive_3dsp_room structure represents the 3D room model, including the reflection and reverberation...
VIVE_3DSP_DISTANCE_MODE
Definition: audio_source.h:22
VIVE_3DSP_BINAURAL_REVERB_ENGINE
Definition: audio_engine.h:95
Definition: audio_source.h:27